Open Finance

Alcances necesarios

El token para consumir la API de saldo y extracto compatible con open finance debe ser generado usando el Authorization Code.

Es necesario informar los siguientes alcances al realizar el flujo:

Alcance	Descripción
empresas.btgpactual.com/accounts.readonly	Acceso a datos de cuenta BTG.
brn:btg:empresas:openfinance:accounts:info.readonly	Acceso base a los recursos de open finance de la cuenta.
brn:btg:empresas:openfinance:accounts:balances.readonly	Acceso a los recursos de open finance de saldo de la cuenta.

¿Cómo lo utilizo?

Antes de que el cliente conceda permiso a la aplicación que consultará el saldo en las instituciones financieras, será necesario autorizar el compartimiento de sus datos con BTG Pactual a través del área de consentimiento

La utilización de la integración es muy simple tanto para el cliente que está construyendo su integración como para el cliente que ya cuenta con una integración previamente construida.

Para consumir los datos de cuentas, basta con llamar al endpoint de Consultar datos de la cuenta pasando como query param accountOrigin con valor OPEN_FINANCE para obtener los datos de sus cuentas en open finance.

Para consumir saldo y extracto, la API es la misma utilizada por el Saldo y Extracto, pero se debe informar el accountId de una cuenta de open finance

Eventos de webhook

Los payloads disponibles a continuación representan el contenido del campo data.

Eventos	Descripción
transactions.credit	Crédito en cuenta
transactions.debit	Débito en cuenta
balance.avaliable	Saldo en cuenta
openfinance-transactions.credit	Crédito en cuenta en open finance
openfinance-transaction.debit	Débito en cuenta en open finance

transactions.credit

{
  "accountId": "25257331000132-208-50-003633854",
  "date": "2023-04-10T13:47:16.146Z",
  "creditDebitIndicator": "CREDIT",
  "amount": 65,
  "currency": "BRL",
  "transactionId": "10000000000",
  "type": "Pix",
  "reason": "",
  "relatedParty": {
    "taxId": "03000000000",
    "bankCode": "000",
    "name": "PEDRO ALVARES CABRAL",
    "currency": "BRL",
    "branchCode": "1000",
    "number": "00000000000000000"
  },
  "payload": {
    "txId": "PIXyz2K7jSRdnDXu9OM09CDdJ",
    "endToEndId": "E00360305202304101345201fa2cd0f3"
  },
  "description": "Pix recebido de PEDRO ALVARES CABRAL PIXyz2K7jSRdnDXu9OM09CDdJ"
}

transactions.credit (boleto)

{
  "accountId": "25257331000132-208-50-003633854",
  "date": "2023-04-10T13:47:16.146Z",
  "creditDebitIndicator": "CREDIT",
  "amount": 65,
  "currency": "BRL",
  "transactionId": "10000000000",
  "type": "Bankslip",
  "febrabanCode":"202",
  "reason": "",
  "relatedParty": {
    "taxId": "03000000000",
    "bankCode": "000",
    "name": "PEDRO ALVARES CABRAL",
    "currency": "BRL",
    "branchCode": "1000",
    "number": "00000000000000000"
  },
  "payload": {
    "barcode": "99899993400000990000099999999050039009999990",
    "ourNumber": "37726891180500390"
  },
  "description":"Boleto pago PEDRO ALVARES CABRAL"
}

transactions.debit

{
  "accountId": "25257331000132-208-50-003633854",
  "date": "2023-04-10T13:47:16.146Z",
  "creditDebitIndicator": "DEBIT",
  "amount": 65,
  "currency": "BRL",
  "transactionId": "10000000000",
  "type": "Pix",
  "reason": "",
  "relatedParty": {
    "taxId": "03000000000",
    "bankCode": "000",
    "name": "PEDRO ALVARES CABRAL",
    "currency": "BRL",
    "branchCode": "1000",
    "number": "00000000000000000"
  },
  "payload": {
    "txId": "PIXyz2K7jSRdnDXu9OM09CDdJ",
    "endToEndId": "E00360305202304101345201fa2cd0f3"
  },
  "description": "Pix recebido de PEDRO ALVARES CABRAL PIXyz2K7jSRdnDXu9OM09CDdJ"
}

balance.avaliable

{
    "accountId": "500000000000-000-00-000000008",
    "bankCode": "000",
    "taxId": "50000000000000",
    "branchCode": "00",
    "number": "000000008",
    "timestamp": "2023-05-09T14:35:52.630961957Z",
    "available": { "amount": 2046 }
}

openfinance-transactions.credit

{
    "accountId": "31333096000333-333-1-3333334033301333333",
    "amount": 1,
    "creditDebitIndicator": "CREDIT",
    "currency": "BRL",
    "date": "2025-02-12T18:13:16.000Z",
    "description": "Outros",
    "relatedParty": {
        "currency": "BRL"
    },
    "taxId": "31333096000333",
    "transactionId": "3e3bfc3e-3333-3301-3336-3333c33a33ca",
    "type": "Outros",
    "tenantId": "31333096000333"
}

openfinance-transactions.debit

{
    "accountId": "31333096000333-333-1-3333334033301333333",
    "amount": 1,
    "creditDebitIndicator": "DEBIT",
    "currency": "BRL",
    "date": "2025-02-12T18:13:16.000Z",
    "description": "Outros",
    "relatedParty": {
        "currency": "BRL"
    },
    "taxId": "31333096000333",
    "transactionId": "3e3bfc3e-3333-3301-3336-3333c33a33ca",
    "type": "Outros",
    "tenantId": "31333096000333"
}